home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / system / dice402.zip / DICE.DOC next >
Text File  |  1990-05-17  |  15KB  |  406 lines
  1. DOS Interactive Command Editor                                  Page 1
  2.  
  3.  
  4.                               TABLE OF CONTENTS
  5.  
  6.         1       INTRODUCTION . . . . . . . . . . . . . . . . . . . . 1
  7.         2       GETTING STARTED  . . . . . . . . . . . . . . . . . . 1
  8.         3       OPERATION  . . . . . . . . . . . . . . . . . . . . . 2
  9.         3.1       To Exit DICE . . . . . . . . . . . . . . . . . . . 2
  10.         3.2       Help . . . . . . . . . . . . . . . . . . . . . . . 2
  11.         3.3       Command Line Editing . . . . . . . . . . . . . . . 2
  12.         3.4       Display And Buffer Operations  . . . . . . . . . . 3
  13.         3.4.1       Command Stack  . . . . . . . . . . . . . . . . . 4
  14.         3.4.2       Command Buffers  . . . . . . . . . . . . . . . . 4
  15.         3.4.3       Argument Buffers . . . . . . . . . . . . . . . . 6
  16.         3.5       Command Prompt . . . . . . . . . . . . . . . . . . 7
  17.         4       PROGRAM AND DOCUMENTATION USAGE  . . . . . . . . . . 8
  18.  
  19.  
  20.  
  21.    Copyright (C) 1986-1990 Eric S. Adams
  22.  
  23.  
  24.  
  25.  
  26. 1  INTRODUCTION
  27.  
  28.      DICE (DOS Interactive Command Editor) is a command line editor.
  29. It provides features which enable more efficient entry of typed-in
  30. commands for DOS or OS/2 full screen command mode.  It's features are:
  31.  
  32.      1.  Enhanced editing capability for the DOS and OS/2 command
  33.          line.
  34.      2.  Saves command line commands on a stack as they are entered.
  35.      3.  Supports tag, save and recall of often used commands and
  36.          arguments.
  37.      4.  Display of tagged arguments, commands and stacked commands.
  38.      5.  Help function that shows a summary of DICE commands.
  39.  
  40.  
  41.  
  42.  
  43. 2  GETTING STARTED
  44.  
  45.      The easiest way to start using DICE is to run the STRTDICE.BAT
  46. file under DOS or the STRTDICE.CMD file under OS/2 full screen command
  47. mode.  These procedures will start either the DOS version or the OS/2
  48. version of DICE.  The DOS executable is DICE.EXE and the OS/2
  49. executable is DICE2.EXE.  At this point, a prompt and command line
  50. appear on the screen and command entry is much like that of DOS or
  51. OS/2 full screen command mode with added features.
  52. DOS Interactive Command Editor                                  Page 2
  53.  
  54.  
  55. 3  OPERATION
  56.  
  57.      The following sections describe the operation and features of
  58. DICE.
  59.  
  60.  
  61.  
  62. 3.1  To Exit DICE
  63.  
  64.      If you want to exit DICE, press <Alt>X (hold the "Alt" key down
  65. while pressing the "X" key).  You will then be asked whether or not
  66. you want to save your commands and buffers.  Pressing the "Y" key will
  67. cause DICE to exit, pressing the "S" key will save the command stack
  68. and buffers to a file and then exit or pressing any other key will
  69. continue.  The location and name of the file used to store the command
  70. stack and buffers is described in the section "Display and Buffer
  71. Operations".
  72.  
  73.  
  74.  
  75. 3.2  Help
  76.  
  77.      You can get help displays of the DICE commands and startup
  78. parameters by pressing <Alt>H or the F1 key.  The first screen gives a
  79. short description of the DICE commands.  If you press "Y" when this
  80. screen is displayed, a short description of the DICE startup command
  81. line arguments is displayed.
  82.  
  83.  
  84.  
  85. 3.3  Command Line Editing
  86.  
  87.      The following list summarizes the basic editing functions for the
  88. DICE command line:
  89.  
  90.      1.  Left or Right arrow - moves cursor one character.
  91.      2.  <Ctrl>Left or <Ctrl>Right arrow - moves cursor one word.
  92.      3.  Home - moves to the start of the command line.
  93.      4.  End - moves to the end of the command line.
  94.      5.  Del - deletes the character at the cursor.
  95.      6.  Backspace - deletes the character in front of the cursor.
  96.      7.  Ins or <Alt>I - toggles the edit mode between insert mode and
  97.          overstrike mode.
  98.      8.  <Alt>K - Deletes from the cursor to the end of the command.
  99.      9.  Toggle command - <Alt>T (or F3) alternately clears the
  100.          command line and moves the command or argument at the pointer
  101.          to the command line.  (The pointer is described in the
  102.          section "Display and Buffer Operations").
  103. DOS Interactive Command Editor                                  Page 3
  104.  
  105.  
  106.     10.  A Semi-colon is a command line delimiter and can be used to
  107.          include comments in the saved command buffers.  For example:
  108.  
  109.             CD C:\MYDIR         ; Change to my directory
  110.  
  111.          If you want to actually enter a semi-colon on the command
  112.          line, type two semi-colons together.  For example:
  113.  
  114.             masm myfile.asm;;
  115.  
  116.          This example will become "masm myfile.asm;".
  117.     11.  A comma is a command delimiter and can be used to put
  118.          multiple commands on a single command line or command buffer.
  119.          For example:
  120.  
  121.             C:,CD C:\MYDIR       ; go to drive c and change to my directory
  122.  
  123.          If you want to actually enter a comma on the command line,
  124.          type two commas together.  For example:
  125.  
  126.             masm myfile.asm,,;;
  127.  
  128.          This example will become "masm myfile.asm,;".
  129.  
  130.  
  131.  
  132.  
  133. 3.4  Display And Buffer Operations
  134.  
  135.      To display the Command Stack and tagged commands and arguments,
  136. press <Alt>B (buffers display).  F2 or <Alt>F2 may also be used to
  137. display the buffers.
  138.  
  139.      The following commands are used to move the buffer pointer.  Note
  140. that these commands are in effect even if the buffers are not being
  141. displayed.
  142.  
  143.      1.  Up or down arrow - moves command/argument pointer up or down
  144.          one position.
  145.      2.  PgUp - scrolls arguments or commands up 5.
  146.      3.  PgDn - scrolls arguments or commands down 5.
  147.      4.  <Alt>N - moves the pointer to the next buffer group.
  148.      5.  <Ctrl>PgUp - moves the pointer up to the command or argument
  149.          buffers section.
  150.      6.  <Ctrl>PgDn - moves the pointer down to the command stack or
  151.          command buffers.
  152.  
  153.  
  154.      Each time DICE is started, it attempts to read the buffer
  155. information from a disk file.  The buffers can be written to this file
  156. by pressing <Alt>S (save buffers).  The information can also be read
  157. from the file by pressing <Alt>F (fill buffers).  The file that is
  158. used is identified by environment variables.  The DOS version uses the
  159. environment variable "DICEDAT" and the OS/2 version uses the variable
  160. "DICE2DAT" to identify the file to use.  For example, if you want to
  161. use a file called "DICE.DAT" in a directory called "c:\util", you can
  162. setup the environment variable as follows:  "set
  163. DOS Interactive Command Editor                                  Page 4
  164.  
  165.  
  166. DICEDAT=c:\util\dice.dat".  Note that environment variables cannot be
  167. set from within DICE.
  168.  
  169.      If the environment variable does not exist, then the DOS version
  170. of DICE uses a file named "DICE370.DAT" and the OS/2 version will use
  171. a file named "DICE2.DAT".  The default files will be located in the
  172. directory that was the current directory at the time DICE was started.
  173.  
  174.  
  175.  
  176. 3.4.1  Command Stack -
  177.  
  178.      As commands are entered and executed, they are pushed onto the
  179. command stack.  The command stack can be displayed along with the
  180. other buffers by pressing <Alt>B.  Previously entered commands are
  181. moved back to the command line as the pointer is moved up or down
  182. through the stack (using the up or down arrow key).  You can also push
  183. a command from the command line onto the stack without executing it by
  184. pressing <Alt>P (push).  When a command is pushed onto the stack, one
  185. of the other commands in the stack is removed.  If an identical
  186. command exists within the stack, it is removed, otherwise the command
  187. at the top of the stack is removed.
  188.  
  189.  
  190.  
  191. 3.4.2  Command Buffers -
  192.  
  193.      The command buffers contain saved commands that can be executed
  194. by entering a user defined pneumonic of alphnumeric characters.  The
  195. default number of characters allowed in a tag is 4, however this can
  196. be configured at startup with a DICE startup command line parameter.
  197. For example, changing the current directory to "c:\project\source" can
  198. be done by entering the command "cd c:\project\source".  You can
  199. define a command called "ps" to do this by typing in the following:
  200.  
  201.    ps=cd c:\project\source<Alt>C
  202.  
  203. This will enter the c